<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>SPHinXsys: SPH::Branch Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">SPHinXsys
   &#160;<span id="projectnumber">alpha version</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespace_s_p_h.html">SPH</a></li><li class="navelem"><a class="el" href="class_s_p_h_1_1_branch.html">Branch</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="class_s_p_h_1_1_branch-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">SPH::Branch Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Each branch has a parent and several children, and geometric information. It is a decorated and realized edge. Many connected branches compose a tree.  
 <a href="class_s_p_h_1_1_branch.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="base__geometry_8h_source.html">base_geometry.h</a>&gt;</code></p>

<p>Inherits <a class="el" href="class_s_p_h_1_1_edge.html">SPH::Edge&lt; size_t, IndexVector &gt;</a>.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a745753f625e8e39e7961f1bb6578cfc8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_branch.html#a745753f625e8e39e7961f1bb6578cfc8">Branch</a> (Vecd init_point, Vecd auxillary_point, <a class="el" href="class_s_p_h_1_1_tree.html">Tree</a> *tree)</td></tr>
<tr class="separator:a745753f625e8e39e7961f1bb6578cfc8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa9cf85fab8a6b3757c40427b3aaa8a48"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_branch.html#aa9cf85fab8a6b3757c40427b3aaa8a48">Branch</a> (<a class="el" href="classsize__t.html">size_t</a> parent_id, <a class="el" href="class_s_p_h_1_1_tree.html">Tree</a> *tree)</td></tr>
<tr class="separator:aa9cf85fab8a6b3757c40427b3aaa8a48"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_s_p_h_1_1_edge"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_s_p_h_1_1_edge')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_s_p_h_1_1_edge.html">SPH::Edge&lt; size_t, IndexVector &gt;</a></td></tr>
<tr class="memitem:aab84200051c417afcf1a401cb6bd280f inherit pub_methods_class_s_p_h_1_1_edge"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_edge.html#aab84200051c417afcf1a401cb6bd280f">Edge</a> (<a class="el" href="classsize__t.html">size_t</a> in_edge)</td></tr>
<tr class="separator:aab84200051c417afcf1a401cb6bd280f inherit pub_methods_class_s_p_h_1_1_edge"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a9c7b7591034781931fdc5b8ab58da904"><td class="memItemLeft" align="right" valign="top">Vecd&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_branch.html#a9c7b7591034781931fdc5b8ab58da904">end_direction_</a></td></tr>
<tr class="separator:a9c7b7591034781931fdc5b8ab58da904"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acb2cdad95aff0734e32f3e1300e4d908"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespace_s_p_h.html#abae56fd7f25f13487c7943ce4681d0ce">IndexVector</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_branch.html#acb2cdad95aff0734e32f3e1300e4d908">inner_points_</a></td></tr>
<tr class="separator:acb2cdad95aff0734e32f3e1300e4d908"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2ec435b6e5a4e13981c97b1dfe68b525"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classbool.html">bool</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_branch.html#a2ec435b6e5a4e13981c97b1dfe68b525">is_end_</a></td></tr>
<tr class="separator:a2ec435b6e5a4e13981c97b1dfe68b525"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_attribs_class_s_p_h_1_1_edge"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_class_s_p_h_1_1_edge')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="class_s_p_h_1_1_edge.html">SPH::Edge&lt; size_t, IndexVector &gt;</a></td></tr>
<tr class="memitem:a987f1047b34f06755f1a2339eafb7b0f inherit pub_attribs_class_s_p_h_1_1_edge"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsize__t.html">size_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_edge.html#a987f1047b34f06755f1a2339eafb7b0f">id_</a></td></tr>
<tr class="separator:a987f1047b34f06755f1a2339eafb7b0f inherit pub_attribs_class_s_p_h_1_1_edge"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9494c203e1bc96a659cfefe457371dec inherit pub_attribs_class_s_p_h_1_1_edge"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classsize__t.html">size_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_edge.html#a9494c203e1bc96a659cfefe457371dec">in_edge_</a></td></tr>
<tr class="separator:a9494c203e1bc96a659cfefe457371dec inherit pub_attribs_class_s_p_h_1_1_edge"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2d0998989e26974827b3ab64d998c943 inherit pub_attribs_class_s_p_h_1_1_edge"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespace_s_p_h.html#abae56fd7f25f13487c7943ce4681d0ce">IndexVector</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_p_h_1_1_edge.html#a2d0998989e26974827b3ab64d998c943">out_edge_</a></td></tr>
<tr class="separator:a2d0998989e26974827b3ab64d998c943 inherit pub_attribs_class_s_p_h_1_1_edge"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Each branch has a parent and several children, and geometric information. It is a decorated and realized edge. Many connected branches compose a tree. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a745753f625e8e39e7961f1bb6578cfc8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a745753f625e8e39e7961f1bb6578cfc8">&#9670;&nbsp;</a></span>Branch() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">SPH::Branch::Branch </td>
          <td>(</td>
          <td class="paramtype">Vecd&#160;</td>
          <td class="paramname"><em>init_point</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">Vecd&#160;</td>
          <td class="paramname"><em>auxillary_point</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="class_s_p_h_1_1_tree.html">Tree</a> *&#160;</td>
          <td class="paramname"><em>tree</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>construct the first or leading-in branch of a tree </p>

</div>
</div>
<a id="aa9cf85fab8a6b3757c40427b3aaa8a48"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa9cf85fab8a6b3757c40427b3aaa8a48">&#9670;&nbsp;</a></span>Branch() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">SPH::Branch::Branch </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classsize__t.html">size_t</a>&#160;</td>
          <td class="paramname"><em>parent_id</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="class_s_p_h_1_1_tree.html">Tree</a> *&#160;</td>
          <td class="paramname"><em>tree</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>construct a branch and connect with its parent </p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a9c7b7591034781931fdc5b8ab58da904"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9c7b7591034781931fdc5b8ab58da904">&#9670;&nbsp;</a></span>end_direction_</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Vecd SPH::Branch::end_direction_</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>direction of the last segment of the branch. </p>

</div>
</div>
<a id="acb2cdad95aff0734e32f3e1300e4d908"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acb2cdad95aff0734e32f3e1300e4d908">&#9670;&nbsp;</a></span>inner_points_</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespace_s_p_h.html#abae56fd7f25f13487c7943ce4681d0ce">IndexVector</a> SPH::Branch::inner_points_</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Inner point indexes of this branch. The first is the last inner point from the parent or init_point, and the last is the first inner point of all its child branches. </p>

</div>
</div>
<a id="a2ec435b6e5a4e13981c97b1dfe68b525"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2ec435b6e5a4e13981c97b1dfe68b525">&#9670;&nbsp;</a></span>is_end_</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classbool.html">bool</a> SPH::Branch::is_end_</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>whether is an end branch or not </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>SPHINXsys/src/shared/geometries/<a class="el" href="base__geometry_8h_source.html">base_geometry.h</a></li>
<li>SPHINXsys/src/shared/geometries/<a class="el" href="base__geometry_8cpp.html">base_geometry.cpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
